home *** CD-ROM | disk | FTP | other *** search
/ World of Video / World of Video.iso / gfxprograms / boards / retina / rblanker.lha / RBlankers / RCurves.doc < prev    next >
Text File  |  1995-02-13  |  12KB  |  303 lines
  1. RCurves Manual
  2. ------------
  3.  
  4.  
  5.      NAME
  6.      ----    
  7.         SYS:WBStartup/RCurves
  8.  
  9.      SYNOPSIS
  10.      --------
  11.         RCurves     CX_POPKEY=<HotKey>
  12.                      CX_POPUP=<YES | NO>
  13.                      BLANKKEY=<HotKey>
  14.                      TIMEOUT=<1 - 3600>
  15.                      CLIENTTIMEOUT=<1 - 60>
  16.                      LINES=<10 - 300>
  17.                      SPEED=<1 - 10>
  18.  
  19.  
  20.      DESCRIPTION
  21.      -----------
  22.           RCurves is a screen blanker with two levels of protection, the
  23.         first of which is an animation of a rotating curved set of
  24.     lines.  If the CPU is to busy, RCurves will default to disabling the 
  25.     screen altogether, preventing the animation from burning into the 
  26.     screen.
  27.  
  28.  
  29.      REQUIREMENTS
  30.      ------------
  31.  
  32.           AmigaDOS 2.04 or better and a Retina graphics card.
  33.  
  34.           68030/040 and 68881/2.
  35.  
  36.      PURPOSE
  37.      -------
  38.  
  39.           RCurves is a screenblanker.  
  40.           
  41.           A screen blanker's goal is to blank (disable) the screen output
  42.         in order to prevent burning images into the monitor's phosphor, but
  43.         just to disabling the screen is boring.  Instead, RCurves displays a
  44.         configurable collection of moving lines to amuse you and to remind
  45.         you that the computer is still running.
  46.  
  47.  
  48.      STARTING
  49.      --------
  50.  
  51.           RCurves is a Commodity, so it only runs under WB 2.04 and higher.
  52.         Just drop it in your WBStartup drawer so that it will load
  53.         automatically upon boot-up.  Just copy RCurves and RCurves.info to
  54.         SYS:WBStartup (or drag its icon to the WBStartup drawer).  It also
  55.         requires the Retina hardware and will not run if you don't have it.
  56.  
  57.           To start RCurves without rebooting, just double-click on its icon.
  58.         If the Tool Types haven't been changed, a window will be displayed.
  59.         This is the "option panel" of RCurves.  To see it blank the screen,
  60.         click on the "Blank" button.  To remove the option panel, click on
  61.         the "Hide" button.
  62.  
  63.           You can also start RCurves from the CLI, just use the form:
  64.  
  65.                   RUN >NIL: <NIL: RCurves {arguments}
  66.  
  67.           The arguments for CLI-Start are exactly the same as the
  68.         ToolTypes,  (See below)
  69.  
  70.  
  71.      ARGUMENTS
  72.      ---------
  73.  
  74.           RCurves supports the standard Tool Type entries for commodities.
  75.         To set them, click on the RCurves icon and select "Information" from
  76.         the Icons menu.  (Please refer to your AmigaDOS Manual for more
  77.         information on commodities and Tool Types.)
  78.  
  79.  
  80.           SUPPORTED TOOL TYPES:
  81.           ---------------------
  82.  
  83.           DONOTWAIT              When started from WBStartup, this lets WB
  84.                                  know that it shouldn't wait for RCurves to
  85.                                  finish.  This tool type should >always< be
  86.                                  present.
  87.           
  88.           STARTPRI=<n>           This sets RCurves' priority to "n".  "n"
  89.                                  should be a number between -120 and 120.
  90.                                  When started from WBStartup, this value
  91.                                  determines RCurves priority in the
  92.                                  commodities list.  It should be a negative
  93.                                  number (i.e., low priority) so that all
  94.                                  other commodities have a chance to modify
  95.                                  the input stream before RCurves sees it.
  96.  
  97.           CX_POPKEY=<HotKey>     This sets the key sequence that will open
  98.                                  RCurves' option panel.  Please see below for
  99.                                  HotKey definitions.  Defaults to "shift
  100.                                  alt s".
  101.  
  102.           CX_POPUP=<YES | NO>    If this is set to "NO"  RCurves will start
  103.                                  silently.  If it is set to anything else,
  104.                                  RCurves will open its option panel when it
  105.                                  starts.
  106.  
  107.           BLANKKEY=<HotKey>      This defines the key sequence that will
  108.                                  instantly blank the screen.  Please see
  109.                                  below for HotKey definitions.  The default
  110.                                  blanking key is "lamiga s".
  111.  
  112.           TIMEOUT=<1 - 3600>     This sets the amount of time over which no
  113.                                  input events may occur in order for the
  114.                                  screen to blank.
  115.  
  116.           CLIENTTIMEOUT=<1 - 6>  This sets the maximum time RCurves will try
  117.                                  to draw the animation.  If RCurves can't
  118.                                  update the animation at least this often,
  119.                                  it will disable the screen.  This keeps
  120.                                  the lines from burning into the monitor,
  121.                                  and it also keeps RCurves from wasting CPU
  122.                                  time when another program needs it.
  123.  
  124.           LINES=<10 - 300>       The number of lines in the curve..
  125.  
  126.           SPEED=<1-10>           The speed (10 is fastest) of the curve.'s
  127.                                  movement.
  128.  
  129.           NOTE: ToolTypes are case-sensitive, so make sure your
  130.         capitalization matches that shown above.
  131.  
  132.  
  133.      DEFAULT TOOL TYPES
  134.      ------------------
  135.  
  136.           When installed, RCurves has the following Tool Types:
  137.  
  138.           DONOTWAIT              # Tell WB to not wait for RCurves to finish.
  139.           CX_POPUP=YES           # Display the window when starting
  140.           STARTPRI=-120          # Sets a low CX priority for starting
  141.  
  142.  
  143.      HOT KEYS
  144.      --------
  145.  
  146.           Refer to your AmigaDOS Manual ("The Extras Programs/The Commodities
  147.         Drawer") to get a valid list of the available hot keys, the following 
  148.     may be obsolete with a new Commodities.library version:
  149.  
  150.         SYNOPSIS:  [<qualifier> [<qualifier>...]] <key>
  151.  
  152.              Qualifier keywords (Press and hold one or more qualifier)
  153.  
  154.              alt                 either Alt key
  155.              ralt                right Alt key
  156.              lalt                left Alt key
  157.              shift               either Shift key
  158.              rshift              right Shift key
  159.              lshift              left Shift key
  160.              capslock            Caps Lock key
  161.              rcommand            right Amiga key
  162.              lcommand            left Amiga key
  163.              control             Control key
  164.              numericpad          Enables the use of a key on the numeric
  165.                                  keypad
  166.              rbutton             Click (and hold) the right mouse button
  167.              midbutton           Click (and hold) the middle mouse button
  168.                                  (only avail for mice with three buttons.)
  169.              leftbutton          Click (and hold) the left mouse button
  170.              newprefs            Preferences changed
  171.              diskremoved         Disk removed
  172.              diskinserted        Disk inserted
  173.  
  174.  
  175.              Keys (to be pressed and released, only ONE Key can be chosen)
  176.  
  177.              a..z, 0..9, etc.    Normal keys
  178.              f1 .. f10           Function keys
  179.              up down left right  Cursor keys
  180.              help                Help key
  181.              del                 Delete key
  182.              return              Return key
  183.              enter               Enter key (MUST be combined with
  184.                                  'numericpad'!)
  185.              backspace           Backspace key
  186.              esc                 Escape key
  187.              space               Space key
  188.              comma               Comma key
  189.              upstroke            Upstroke key
  190.  
  191.  
  192.              Examples:
  193.  
  194.                   lalt ralt enter
  195.                   ramiga f10
  196.                   alt x
  197.                   lalt numericpad enter
  198.  
  199.           NOTE: Choose your hotkeys carefully.  Commodities can change the
  200.         way standard keys operate, and if you assign "a" to blank the
  201.         screen, then the screen will blank every time you push it - even
  202.         when you're trying to type.
  203.  
  204.           If you try to use an illegal hot key combination, RCurves will not
  205.         start, but will display an error message, instead.  Some examples
  206.         of illegal hot keys are:
  207.  
  208.           lalt a b               # Two keys specified
  209.           leftbutton             # No key specified
  210.           control lcommand rcommand   # Reboots the system (oops!)
  211.  
  212.      EDIT WINDOW
  213.      -----------
  214.  
  215.           Some RCurves settings can be changed while RCurves is executing.  To
  216.         change the settings, open the RCurves option window by pressing the
  217.         CX_POPKEY sequence you defined.  Changes made in the option window
  218.         will not be saved.
  219.  
  220.         When the option panel opens, you will see some gadgets and a
  221.      scrollable list of display modes.
  222.  
  223.           TIMER:                 The value for the timeout of the blanker.
  224.                                  After this time (in seconds) the blanker
  225.                                  will display the animation. TIMER may have a
  226.                                  value between between 1 and 3600.
  227.  
  228.           CLIENT TIMEOUT:        The time RCurves gives the animation
  229.                                  routines to update the screen.  If the
  230.                                  animation routines exceed this limit, the
  231.                                  screen will be blacked out to prevent
  232.                                  burn-ins.
  233.  
  234.           SPEED:                 The maximum pixels per frame the lines will
  235.                                  move.
  236.  
  237.           LINES:                 The number of lines.
  238.  
  239.           HIDE:                  (click or press 'h') Closes the option
  240.                                  window, without stopping RCurves.
  241.  
  242.           BLANK:                 (click or press 'b') Immediately blanks
  243.                                  the screen.
  244.  
  245.           QUIT:                  (click or press 'q') Quit.
  246.  
  247.      COMMODITIES EXCHANGE
  248.      --------------------
  249.  
  250.         With the Exchange tool, you can temporarly disable or permanently
  251.      kill RCurves and other commodities.  Please refer to the AmigaDOS Manual
  252.      (Section AmigaDOS Reference and Workbench Programs) for further
  253.      information on Exchange.
  254.  
  255.      COMMON PROBLEMS
  256.      ---------------
  257.  
  258.      1)   You are running a C-Compiler or a raytracer.  RCurves blanks but
  259.           doesn't show the lines, or the lines only appear erraticly.
  260.  
  261.           If the CPU usage is high, RCurves will simply blank the screen.
  262.           This keeps RCurves from degrading the speed of other processes, and
  263.           it prevents the animation from burning the monitor by getting stuck 
  264.       in one place too long.
  265.  
  266.           Another time this can occur is when you're using all the Retina's
  267.           video memory for other screens.  If this happens, RCurves will
  268.           first try to open a low resolution screen instead of the normal
  269.           high res one.  If >that< fails, RCurves will resort to simply
  270.           blanking the screen.
  271.      
  272.      2)   RCurves blanks the screen, but the lines are all lo-res and chunky
  273.           looking. (whine whine)
  274.      
  275.           See the previous note.  If RCurves can't open a high res screen, it
  276.           tries to open a low-res one.  If that fails, it just blacks out
  277.           the screen.
  278.  
  279.      3)   When a disk is inserted, RCurves "unblanks".  This is normal.
  280.           Disk-replacement is detected as an input event. As all input
  281.           events disable the blanker, this one does as well.
  282.  
  283.      4)   RCurves displays the window though the Tool Type CX_POPUP is set to
  284.           'NO'.
  285.  
  286.           This happens when RCurves is started but another copy is already
  287.           running.
  288.  
  289.      CREDITS
  290.      -------
  291.  
  292.           Much of the code style and technique of this blanker was inspired
  293.         by the PD blanker ASwarmIII by Jake Rose.  He did a good job
  294.         showing me how it's done.
  295.  
  296.      AUTHOR
  297.      ------
  298.      
  299.           Michael Heinz
  300.       William Henry Apts, #OAK-123
  301.       Malvern, PA 19355
  302.       (610)-251-3361
  303.